Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

WIP: Add APIs page for JS #12605

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from
Draft

WIP: Add APIs page for JS #12605

wants to merge 7 commits into from
+324 −131

Conversation

mydea
Copy link
Member

@mydea mydea commented Feb 6, 2025 •
edited by stephanie-anderson
Loading

This is very much WIP. It adds a new "APIs" page to JS docs that should eventually have all the top level APIs in it.

Example API references:

@mydea mydea self-assigned this Feb 6, 2025
@vercel Vercel
Copy link

vercel bot commented Feb 6, 2025 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 6, 2025 4:16pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Feb 6, 2025 4:16pm
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Feb 6, 2025 4:16pm

@codecov Codecov
Copy link

codecov bot commented Feb 6, 2025 •
edited
Loading

Bundle Report

Changes will increase total bundle size by 11.98kB (0.06%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.72MB 11.62kB (0.11%) ⬆️
sentry-docs-client-array-push 9.38MB 354 bytes (0.0%) ⬆️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.64MB -0.0%
3603.js (New) 1.04MB 1.04MB 100.0% 🚀
../instrumentation.js -3 bytes 968.3kB -0.0%
9523.js -3 bytes 944.51kB -0.0%
../app/[[...path]]/page.js 11.1kB 540.51kB 2.1%
../app/[[...path]]/page.js.nft.json 56 bytes 376.11kB 0.01%
../app/platform-redirect/page.js.nft.json 56 bytes 376.03kB 0.01%
../app/sitemap.xml/route.js.nft.json 56 bytes 374.0kB 0.01%
4899.js (Deleted) -1.04MB 0 bytes -100.0% 🗑️

Files in ../app/[[...path]]/page.js:

  • ./src/mdxComponents.ts → Total Size: 3.6kB

  • ./src/components/sdkApi.tsx → Total Size: 3.46kB

  • ./src/components/sdkOption.tsx → Total Size: 4.53kB

  • ./src/components/sdkDefinition/index.tsx → Total Size: 3.14kB

  • ./src/components/sdkDefinition/style.module.scss → Total Size: 86 bytes

App Routes Affected:

App Route Size Change Total Size Change (%)
/[[...path]] 11.1kB 3.09MB 0.36%
view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 865.95kB -0.0%
static/css/*.css 129 bytes 22.89kB 0.57%
static/css/*.css 209 bytes 739.38kB 0.03%
static/chunks/7801-*.js -3 bytes 391.02kB -0.0%
server/app/_not-*.js 5 bytes 252.09kB 0.0%
server/app/[[...path]]/page_client-*.js 5 bytes 252.05kB 0.0%
server/app/platform-*.js 5 bytes 237.38kB 0.0%
static/chunks/app/[[...path]]/page-*.js 7 bytes 72.42kB 0.01%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/Rie6DVUga3SB9MPB6Csxj/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/Rie6DVUga3SB9MPB6Csxj/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/Z9lX2EChrItKnPgUNLkL-*.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/Z9lX2EChrItKnPgUNLkL-*.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️

Files in static/chunks/app/[[...path]]/page-*.js:

  • ./src/components/sdkDefinition/style.module.scss → Total Size: 110 bytes

@philipphofmann
Copy link
Member

I think it would be better to change the parameters to use the full width and have the object description below them. Now we have plenty of unused space and the object parameters could use the full width instead.

CleanShot 2025-02-07 at 10 19 30@2x

Instead of
breadcrumb description
hint description

Do this
breadcrumb
description
hint
description

How does that sound?

@timfish
Copy link
Collaborator

timfish commented Feb 7, 2025

Oooh, nice!

Don't forget dark mode:

image

@mydea
Copy link
Member Author

mydea commented Feb 7, 2025

I think it would be better to change the parameters to use the full width and have the object description below them. Now we have plenty of unused space and the object parameters could use the full width instead.

Yeah, I think that makes sense. I agree it is a bit wasteful as-is. This is really an early draft so def. needs some more love :D Also re: dark mode, this def. needs to be done, true!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@mydea mydea

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@mydea @philipphofmann @timfish